<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <link href="stable/static/css/site.css" rel="stylesheet" type="text/css">
    <link href="stable/static/css/print.css" rel="stylesheet" type="text/css" media="print">
    <link href="stable/static/css/prettify.css" rel="stylesheet" type="text/css">
    <link href="//www.google.com/images/icons/product/chrome-16.png" rel="icon" type="image/ico">
    <link href="stable/static/css/api.css" rel="stylesheet" type="text/css">
    <title>chrome.cookies - chrome插件中文开发文档(非官方)</title>
  </head>
  <body>
    <a id="top"></a>
    <div id="header">{Header content}</div>
    <a id="gc-topnav-anchor"></a>
    <div id="gc-topnav">
      <h1>Google Chrome Extensions</h1>
      <ul id="home" class="gc-topnav-tabs">
        <li id="home_link">
          <a href="index.html" title="Google Chrome Extensions home page"><div>Home</div></a>
        </li>
        <li id="docs_link">
          <a href="docs.html" title="Official Google Chrome Extensions documentation"><div>Docs</div></a>
        </li>
        <li id="faq_link">
          <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions"><div>FAQ</div></a>
        </li>
        <li id="samples_link">
          <a href="samples.html" title="Sample Extensions (with source code)"><div>Samples</div></a>
        </li>
        <li id="group_link">
          <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum"><div>Group</div></a>
        </li>
        <li id="so_link">
          <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><div>Questions?</div></a>
        </li>
      </ul>
    </div>
    <div id="gc-container">
      <div id="gc-sidebar">
        <ul 
            class="level1 ">
          <li class="level2">
                <a href="getstarted.html" class="level2 ">Getting Started</a>
          </li>
          <li class="level2">
                <a href="overview.html" class="level2 ">Overview</a>
          </li>
          <li class="level2">
                <a href="whats_new.html" class="level2 ">What's New?</a>
          </li>
          <li class="level2">
                <a href="devguide.html" class="level2 ">Developer's Guide</a>
              <ul 
                  class="level2 ">
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Browser UI</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="browserAction.html" class="level4 ">Browser Actions</a>
                      </li>
                      <li class="level4">
                            <a href="contextMenus.html" class="level4 ">Context Menus</a>
                      </li>
                      <li class="level4">
                            <a href="notifications.html" class="level4 ">Desktop Notifications</a>
                      </li>
                      <li class="level4">
                            <a href="omnibox.html" class="level4 ">Omnibox</a>
                      </li>
                      <li class="level4">
                            <a href="options.html" class="level4 ">Options Pages</a>
                      </li>
                      <li class="level4">
                            <a href="override.html" class="level4 ">Override Pages</a>
                      </li>
                      <li class="level4">
                            <a href="pageAction.html" class="level4 ">Page Actions</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Browser Interaction</span>
                      <div class="toggleIndicator level3 toggled"></div>
                    </a>
                    <ul toggleable
                        class="level3 ">
                      <li class="level4">
                            <a href="bookmarks.html" class="level4 ">Bookmarks</a>
                      </li>
                      <li class="level4">
                            <a  class="level4 selected">Cookies</a>
                      </li>
                      <li class="level4">
                            <a href="devtools.html" class="level4 ">Developer Tools</a>
                      </li>
                      <li class="level4">
                            <a href="events.html" class="level4 ">Events</a>
                      </li>
                      <li class="level4">
                            <a href="history.html" class="level4 ">History</a>
                      </li>
                      <li class="level4">
                            <a href="management.html" class="level4 ">Management</a>
                      </li>
                      <li class="level4">
                            <a href="tabs.html" class="level4 ">Tabs</a>
                      </li>
                      <li class="level4">
                            <a href="windows.html" class="level4 ">Windows</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Implementation</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="a11y.html" class="level4 ">Accessibility</a>
                      </li>
                      <li class="level4">
                            <a href="event_pages.html" class="level4 ">Event Pages</a>
                      </li>
                      <li class="level4">
                            <a href="contentSecurityPolicy.html" class="level4 ">Content Security Policy</a>
                      </li>
                      <li class="level4">
                            <a href="content_scripts.html" class="level4 ">Content Scripts</a>
                      </li>
                      <li class="level4">
                            <a href="xhr.html" class="level4 ">Cross-Origin XHR</a>
                      </li>
                      <li class="level4">
                            <a href="i18n.html" class="level4 ">Internationalization</a>
                      </li>
                      <li class="level4">
                            <a href="messaging.html" class="level4 ">Message Passing</a>
                      </li>
                      <li class="level4">
                            <a href="permissions.html" class="level4 ">Optional Permissions</a>
                      </li>
                      <li class="level4">
                            <a href="npapi.html" class="level4 ">NPAPI Plugins</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Finishing</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="hosting.html" class="level4 ">Hosting</a>
                      </li>
                      <li class="level4">
                            <a href="external_extensions.html" class="level4 ">Other Deployment Options</a>
                      </li>
                    </ul>
                </li>
              </ul>
          </li>
          <li class="level2">
                <a href="tutorials.html" class="level2 ">Tutorials</a>
              <ul 
                  class="level2 ">
                <li class="level3">
                      <a href="tut_migration_to_manifest_v2.html" class="level3 ">Manifest V2</a>
                </li>
                <li class="level3">
                      <a href="tut_debugging.html" class="level3 ">Debugging</a>
                </li>
                <li class="level3">
                      <a href="tut_analytics.html" class="level3 ">Google Analytics</a>
                </li>
                <li class="level3">
                      <a href="tut_oauth.html" class="level3 ">OAuth</a>
                </li>
              </ul>
          </li>
          <li class="level2">
                <span class="level2">Reference</span>
              <ul 
                  class="level2 ">
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Formats</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="manifest.html" class="level4 ">Manifest Files</a>
                      </li>
                      <li class="level4">
                            <a href="match_patterns.html" class="level4 ">Match Patterns</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                      <a href="permission_warnings.html" class="level3 ">Permission Warnings</a>
                </li>
                <li class="level3">
                      <a href="api_index.html" class="level3 ">chrome.* APIs</a>
                </li>
                <li class="level3">
                      <a href="api_other.html" class="level3 ">Other APIs</a>
                </li>
              </ul>
          </li>
          <li class="level2">
                <span class="level2">More</span>
              <ul 
                  class="level2 ">
                <li class="level3">
                      <a href="http://code.google.com/chrome/webstore/docs/index.html" class="level3 ">Chrome Web Store</a>
                </li>
                <li class="level3">
                      <a href="http://code.google.com/chrome/apps/docs/developers_guide.html" class="level3 ">Hosted Apps</a>
                </li>
                <li class="level3">
                      <a href="themes.html" class="level3 ">Themes</a>
                </li>
              </ul>
          </li>
        </ul>
      </div>
      <div id="gc-pagecontent">
        <h1 class="page_title">chrome.cookies</h1>
        
        
        
        <div id="toc">
          <h2>Contents</h2>
          <ol>
            <li>
              <a href=#manifest>Manifest</a>
            </li>
            <li>
              <a href=#examples> Examples </a>
            </li>
            <li>
              <a href="#apiReference">API reference: chrome.cookies</a>
              <ol>
                  <li><a href="#types">Types</a><ol>  <li>    <a href="#type-Cookie">Cookie</a>  </li>  <li>    <a href="#type-CookieStore">CookieStore</a>  </li></ol></li>
                  
                  <li><a href="#methods">Methods</a><ol>  <li><a href="#method-get">get</a></li>  <li><a href="#method-getAll">getAll</a></li>  <li><a href="#method-set">set</a></li>  <li><a href="#method-remove">remove</a></li>  <li><a href="#method-getAllCookieStores">getAllCookieStores</a></li></ol></li>
                  <li><a href="#events">Events</a><ol>  <li><a href="#event-onChanged">onChanged</a></li></ol></li>
                  <li><a href="#samples">Sample Extensions</a></li>
              </ol>
            </li>
          </ol>
        </div>

<h2 id="manifest">Manifest</h2>

<p>To use the cookies API,
you must declare the "cookies" permission in your manifest,
along with <a href="manifest.html#permissions">host permissions</a>
for any hosts whose cookies
you want to access.
For example:</p>

<pre>{
  "name": "My extension",
  ...
  <b>"permissions": [
    "cookies",
    "*://*.google.com"
  ]</b>,
  ...
}</pre>

<h2 id="examples"> Examples </h2>

<p>
You can find a simple example
of using the cookies API in the
<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/cookies/">examples/api/cookies</a>
directory.
For other examples
and for help in viewing the source code,
see <a href="samples.html">Samples</a>.
</p>
        <h2 id="apiReference">API Reference: chrome.cookies</h2>
        <div class="api_reference">
            <h3 id="types">Types</h3>
              <div>
                <h3 id="type-Cookie">Cookie</h3>
                <div>
                  <dt><span class="type_name">  (    <span id="typeTemplate">object</span>  )</span></dt>
              <dd>
                    Represents information about an HTTP cookie.
                  </dd>    <h4 id="Cookie-properties">
                    Properties of <a href="#type-Cookie">Cookie</a>
                  </h4>
                  <dd><dl>      <div>
                      <a name="property-Cookie-name"></a>
                      <dt>
                        <span class="variable">name</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">string</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The name of the cookie.
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-value"></a>
                      <dt>
                        <span class="variable">value</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">string</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The value of the cookie.
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-domain"></a>
                      <dt>
                        <span class="variable">domain</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">string</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The domain of the cookie (e.g. "www.google.com", "example.com").
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-hostOnly"></a>
                      <dt>
                        <span class="variable">hostOnly</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">boolean</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-path"></a>
                      <dt>
                        <span class="variable">path</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">string</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The path of the cookie.
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-secure"></a>
                      <dt>
                        <span class="variable">secure</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">boolean</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-httpOnly"></a>
                      <dt>
                        <span class="variable">httpOnly</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">boolean</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-session"></a>
                      <dt>
                        <span class="variable">session</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">boolean</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-expirationDate"></a>
                      <dt>
                        <span class="variable">expirationDate</span>
                        <span class="property">
                          (
                            <span class="optional">optional</span>
                            <span id="typeTemplate">double</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.
                      </dd>
                    </div>
                    <div>
                      <a name="property-Cookie-storeId"></a>
                      <dt>
                        <span class="variable">storeId</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">string</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The ID of the cookie store containing this cookie, as provided in getAllCookieStores().
                      </dd>
                    </div>
              </dl></dd>
                </div>
              </div>
              <div>
                <h3 id="type-CookieStore">CookieStore</h3>
                <div>
                  <dt><span class="type_name">  (    <span id="typeTemplate">object</span>  )</span></dt>
              <dd>
                    Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.
                  </dd>    <h4 id="CookieStore-properties">
                    Properties of <a href="#type-CookieStore">CookieStore</a>
                  </h4>
                  <dd><dl>      <div>
                      <a name="property-CookieStore-id"></a>
                      <dt>
                        <span class="variable">id</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">string</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The unique identifier for the cookie store.
                      </dd>
                    </div>
                    <div>
                      <a name="property-CookieStore-tabIds"></a>
                      <dt>
                        <span class="variable">tabIds</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">array of integer</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        Identifiers of all the browser tabs that share this cookie store.
                      </dd>
                    </div>
              </dl></dd>
                </div>
              </div>
            <h3 id="methods">Methods</h3>
              <div>
                <h4 id="method-get">get</h4>
                <div class="summary lower">
                  <span>chrome.cookies.get</span>(<span>object <span class="variable">details</span></span>)
                </div>
                <div class="description">
              <p>
                    Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-get-details"></a>  <dt>    <span class="variable">details</span>    <span class="property">      (                <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    Details to identify the cookie being retrieved.  </dd>  <dd>    <dl>      <div>        <a name="property-details-url"></a>        <dt>          <span class="variable">url</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the manifest file, the API call will fail.        </dd>      </div>      <div>        <a name="property-details-name"></a>        <dt>          <span class="variable">name</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The name of the cookie to retrieve.        </dd>      </div>      <div>        <a name="property-details-storeId"></a>        <dt>          <span class="variable">storeId</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used.        </dd>      </div>    </dl>  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      The <em>callback</em> parameter should specify a function      that looks like this:</p><pre>function(<a href="cookies.html#type-Cookie">Cookie</a> cookie) <span class="subdued">{...}</span>;</pre><dl>  <div>  <a name="property-callback-cookie"></a>  <dt>    <span class="variable">cookie</span>    <span class="property">      (        <span class="optional">optional</span>        <span id="typeTemplate"><a href="cookies.html#type-Cookie">Cookie</a></span>      )    </span>  </dt>  <dd>    Contains details about the cookie. This parameter is null if no such cookie was found.  </dd></div></dl>
                </div>
              </div>
              <div>
                <h4 id="method-getAll">getAll</h4>
                <div class="summary lower">
                  <span>chrome.cookies.getAll</span>(<span>object <span class="variable">details</span></span>)
                </div>
                <div class="description">
              <p>
                    Retrieves all cookies from a single cookie store that match the given information.  The cookies returned will be sorted, with those with the longest path first.  If multiple cookies have the same path length, those with the earliest creation time will be first.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-getAll-details"></a>  <dt>    <span class="variable">details</span>    <span class="property">      (                <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    Information to filter the cookies being retrieved.  </dd>  <dd>    <dl>      <div>        <a name="property-details-url"></a>        <dt>          <span class="variable">url</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          Restricts the retrieved cookies to those that would match the given URL.        </dd>      </div>      <div>        <a name="property-details-name"></a>        <dt>          <span class="variable">name</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          Filters the cookies by name.        </dd>      </div>      <div>        <a name="property-details-domain"></a>        <dt>          <span class="variable">domain</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          Restricts the retrieved cookies to those whose domains match or are subdomains of this one.        </dd>      </div>      <div>        <a name="property-details-path"></a>        <dt>          <span class="variable">path</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          Restricts the retrieved cookies to those whose path exactly matches this string.        </dd>      </div>      <div>        <a name="property-details-secure"></a>        <dt>          <span class="variable">secure</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">boolean</span>            )          </span>        </dt>        <dd>          Filters the cookies by their Secure property.        </dd>      </div>      <div>        <a name="property-details-session"></a>        <dt>          <span class="variable">session</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">boolean</span>            )          </span>        </dt>        <dd>          Filters out session vs. persistent cookies.        </dd>      </div>      <div>        <a name="property-details-storeId"></a>        <dt>          <span class="variable">storeId</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.        </dd>      </div>    </dl>  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      The <em>callback</em> parameter should specify a function      that looks like this:</p><pre>function(array of <a href="cookies.html#type-Cookie">Cookie</a> cookies) <span class="subdued">{...}</span>;</pre><dl>  <div>  <a name="property-callback-cookies"></a>  <dt>    <span class="variable">cookies</span>    <span class="property">      (                <span id="typeTemplate">array of <a href="cookies.html#type-Cookie">Cookie</a></span>      )    </span>  </dt>  <dd>    All the existing, unexpired cookies that match the given cookie info.  </dd></div></dl>
                </div>
              </div>
              <div>
                <h4 id="method-set">set</h4>
                <div class="summary lower">
                  <span>chrome.cookies.set</span>(<span>object <span class="variable">details</span></span>)
                </div>
                <div class="description">
              <p>
                    Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-set-details"></a>  <dt>    <span class="variable">details</span>    <span class="property">      (                <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    Details about the cookie being set.  </dd>  <dd>    <dl>      <div>        <a name="property-details-url"></a>        <dt>          <span class="variable">url</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.        </dd>      </div>      <div>        <a name="property-details-name"></a>        <dt>          <span class="variable">name</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The name of the cookie. Empty by default if omitted.        </dd>      </div>      <div>        <a name="property-details-value"></a>        <dt>          <span class="variable">value</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The value of the cookie. Empty by default if omitted.        </dd>      </div>      <div>        <a name="property-details-domain"></a>        <dt>          <span class="variable">domain</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The domain of the cookie. If omitted, the cookie becomes a host-only cookie.        </dd>      </div>      <div>        <a name="property-details-path"></a>        <dt>          <span class="variable">path</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The path of the cookie. Defaults to the path portion of the url parameter.        </dd>      </div>      <div>        <a name="property-details-secure"></a>        <dt>          <span class="variable">secure</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">boolean</span>            )          </span>        </dt>        <dd>          Whether the cookie should be marked as Secure. Defaults to false.        </dd>      </div>      <div>        <a name="property-details-httpOnly"></a>        <dt>          <span class="variable">httpOnly</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">boolean</span>            )          </span>        </dt>        <dd>          Whether the cookie should be marked as HttpOnly. Defaults to false.        </dd>      </div>      <div>        <a name="property-details-expirationDate"></a>        <dt>          <span class="variable">expirationDate</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">double</span>            )          </span>        </dt>        <dd>          The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.        </dd>      </div>      <div>        <a name="property-details-storeId"></a>        <dt>          <span class="variable">storeId</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store.        </dd>      </div>    </dl>  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      If you specify the <em>callback</em> parameter, it should      specify a function that looks like this:</p><pre>function(<a href="cookies.html#type-Cookie">Cookie</a> cookie) <span class="subdued">{...}</span>;</pre><dl>  <div>  <a name="property-callback-cookie"></a>  <dt>    <span class="variable">cookie</span>    <span class="property">      (        <span class="optional">optional</span>        <span id="typeTemplate"><a href="cookies.html#type-Cookie">Cookie</a></span>      )    </span>  </dt>  <dd>    Contains details about the cookie that's been set.  If setting failed for any reason, this will be "null", and "chrome.extension.lastError" will be set.  </dd></div></dl>
                </div>
              </div>
              <div>
                <h4 id="method-remove">remove</h4>
                <div class="summary lower">
                  <span>chrome.cookies.remove</span>(<span>object <span class="variable">details</span></span>)
                </div>
                <div class="description">
              <p>
                    Deletes a cookie by name.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-remove-details"></a>  <dt>    <span class="variable">details</span>    <span class="property">      (                <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    Information to identify the cookie to remove.  </dd>  <dd>    <dl>      <div>        <a name="property-details-url"></a>        <dt>          <span class="variable">url</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.        </dd>      </div>      <div>        <a name="property-details-name"></a>        <dt>          <span class="variable">name</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The name of the cookie to remove.        </dd>      </div>      <div>        <a name="property-details-storeId"></a>        <dt>          <span class="variable">storeId</span>          <span class="property">            (              <span class="optional">optional</span>              <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The ID of the cookie store to look in for the cookie. If unspecified, the cookie is looked for by default in the current execution context's cookie store.        </dd>      </div>    </dl>  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      If you specify the <em>callback</em> parameter, it should      specify a function that looks like this:</p><pre>function(object details) <span class="subdued">{...}</span>;</pre><dl>  <div>  <a name="property-callback-details"></a>  <dt>    <span class="variable">details</span>    <span class="property">      (        <span class="optional">optional</span>        <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    Contains details about the cookie that's been removed.  If removal failed for any reason, this will be "null", and "chrome.extension.lastError" will be set.  </dd>  <dd>    <dl>      <div>        <a name="property-details-url"></a>        <dt>          <span class="variable">url</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The URL associated with the cookie that's been removed.        </dd>      </div>      <div>        <a name="property-details-name"></a>        <dt>          <span class="variable">name</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The name of the cookie that's been removed.        </dd>      </div>      <div>        <a name="property-details-storeId"></a>        <dt>          <span class="variable">storeId</span>          <span class="property">            (                            <span id="typeTemplate">string</span>            )          </span>        </dt>        <dd>          The ID of the cookie store from which the cookie was removed.        </dd>      </div>    </dl>  </dd></div></dl>
                </div>
              </div>
              <div>
                <h4 id="method-getAllCookieStores">getAllCookieStores</h4>
                <div class="summary lower">
                  <span>chrome.cookies.getAllCookieStores</span>()
                </div>
                <div class="description">
              <p>
                    Lists all existing cookie stores.
                  </p>  </div>
              </div>
            <h3 id="events">Events</h3>
              <div>
                <h4 id="event-onChanged">onChanged</h4>
                <div class="summary">
                  <span class="subdued">chrome.cookies.</span>onChanged<span class="subdued">.addListener</span>(function(<span>object <span class="variable">changeInfo</span></span>)<span class="subdued"> {...}</span>);
                </div>
                <div class="description">
              <p>
                    Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" .  Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit".
                  </p>      <h4>Listener Parameters</h4>
                    <dl>
                      <div>  <a name="property-onChanged-changeInfo"></a>  <dt>    <span class="variable">changeInfo</span>    <span class="property">      (                <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    <dl>      <div>        <a name="property-changeInfo-removed"></a>        <dt>          <span class="variable">removed</span>          <span class="property">            (                            <span id="typeTemplate">boolean</span>            )          </span>        </dt>        <dd>          True if a cookie was removed.        </dd>      </div>      <div>        <a name="property-changeInfo-cookie"></a>        <dt>          <span class="variable">cookie</span>          <span class="property">            (                            <span id="typeTemplate"><a href="cookies.html#type-Cookie">Cookie</a></span>            )          </span>        </dt>        <dd>          Information about the cookie that was set or removed.        </dd>      </div>      <div>        <a name="property-changeInfo-cause"></a>        <dt>          <span class="variable">cause</span>          <span class="property">            (                            <span id="typeTemplate">enumerated string ["evicted", "expired", "explicit", "expired_overwrite", "overwrite"]</span>            )          </span>        </dt>        <dd>          The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to "chrome.cookies.remove", "cause" will be "explicit". If a cookie was automatically removed due to expiry, "cause" will be "expired". If a cookie was removed due to being overwritten with an already-expired expiration date, "cause" will be set to "expired_overwrite".  If a cookie was automatically removed due to garbage collection, "cause" will be "evicted".  If a cookie was automatically removed due to a "set" call that overwrote it, "cause" will be "overwrite". Plan your response accordingly.        </dd>      </div>    </dl>  </dd></div>
                    </dl>
                </div>
              </div>
        </div>
          <h2 id="samples">Sample Extensions that use chrome.cookies</h2>
            <li><strong><a href="samples.html#2b0f7d02f3ebd51358ed54ef59dceebb">Cookie API Test Extension</a></strong> &ndash;
            Testing Cookie API
        </li>
      </div>
    </div>
  </body>
  <script>
    window.bootstrap = {
      api_names: [{"name":"alarms"},{"name":"bookmarks"},{"name":"browserAction"},{"name":"browsingData"},{"name":"commands"},{"name":"contentSettings"},{"name":"contextMenus"},{"name":"cookies"},{"name":"debugger"},{"name":"declarativeWebRequest"},{"name":"devtools.inspectedWindow"},{"name":"devtools.network"},{"name":"devtools.panels"},{"name":"downloads"},{"name":"events"},{"name":"extension"},{"name":"fileBrowserHandler"},{"name":"fontSettings"},{"name":"history"},{"name":"i18n"},{"name":"idle"},{"name":"input.ime"},{"name":"management"},{"name":"omnibox"},{"name":"pageAction"},{"name":"pageCapture"},{"name":"permissions"},{"name":"privacy"},{"name":"proxy"},{"name":"runtime"},{"name":"scriptBadge"},{"name":"storage"},{"name":"tabs"},{"name":"topSites"},{"name":"tts"},{"name":"ttsEngine"},{"name":"types"},{"name":"webNavigation"},{"name":"webRequest"},{"name":"webstore"},{"last":true,"name":"windows"}].concat(
          [{"name":"experimental.bluetooth"},{"name":"experimental.devtools.audits"},{"name":"experimental.devtools.console"},{"name":"experimental.discovery"},{"name":"experimental.identity"},{"name":"experimental.infobars"},{"name":"experimental.offscreenTabs"},{"name":"experimental.processes"},{"name":"experimental.record"},{"name":"experimental.speechInput"},{"name":"experimental.systemInfo.cpu"},{"name":"experimental.systemInfo.storage"},{"last":true,"name":"experimental.usb"}]),
      branchInfo: {"channels":[{"path":"stable","name":"Stable"},{"path":"dev","name":"Dev"},{"path":"beta","name":"Beta"},{"path":"trunk","name":"Trunk"}],"current":"stable","showWarning":false}
    };
  </script>
  <div id="gc-footer">
    <div class="text">
      <p>
        Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
        the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
        Attribution 3.0 License</a>, and code samples are licensed under the
        <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
      </p>
      <p>
        ©2012 Google
      </p>
      <script src="stable/static/js/branch.js" type="text/javascript"></script>
      <script src="stable/static/js/sidebar.js" type="text/javascript"></script>
      <script src="stable/static/js/prettify.js" type="text/javascript"></script>
      <script>
        (function() {
          // Auto syntax highlight all pre tags.
          var preElements = document.getElementsByTagName('pre');
          for (var i = 0; i < preElements.length; i++)
            preElements[i].classList.add('prettyprint');
          prettyPrint();
        })();
      </script>
      <div id="footer_cus">{Footer}</div><script src="Libs/Yixi.js"></script><script src="http://s9.cnzz.com/stat.php?id=4928336&web_id=4928336" language="JavaScript"></script>
  
    </div>
  </div>
</html>
